<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-types.html" />
<link rel="prev" href="module-UserList.html" />
<link rel="parent" href="datatypes.html" />
<link rel="next" href="module-types.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>5.14 UserString -- Class wrapper for string objects</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="5.13 userlist  "
  href="module-UserList.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="5. data Types"
  href="datatypes.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="5.15 types  "
  href="module-types.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-UserList.html">5.13 UserList  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="datatypes.html">5. Data Types</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-types.html">5.15 types  </a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0071400000000000000000">
5.14 <tt class="module">UserString</tt> --
         Class wrapper for string objects</a>
</h1>

<p>
<a name="module-UserString"></a>

<p>
<span class="note"><b class="label">Note:</b>
This <tt class="class">UserString</tt> class from this module is available for
backward compatibility only.  If you are writing code that does not
need to work with versions of Python earlier than Python 2.2, please
consider subclassing directly from the built-in <tt class="class">str</tt> type
instead of using <tt class="class">UserString</tt> (there is no built-in equivalent
to <tt class="class">MutableString</tt>).</span>

<p>
This module defines a class that acts as a wrapper around string
objects.  It is a useful base class for your own string-like classes,
which can inherit from them and override existing methods or add new
ones.  In this way one can add new behaviors to strings.

<p>
It should be noted that these classes are highly inefficient compared
to real string or Unicode objects; this is especially the case for
<tt class="class">MutableString</tt>.

<p>
The <tt class="module">UserString</tt> module defines the following classes:

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-841' xml:id='l2h-841' class="class">UserString</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>sequence</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Class that simulates a string or a Unicode string
object.  The instance's content is kept in a regular string or Unicode
string object, which is accessible via the <tt class="member">data</tt> attribute of
<tt class="class">UserString</tt> instances.  The instance's contents are initially
set to a copy of <var>sequence</var>.  <var>sequence</var> can be either a
regular Python string or Unicode string, an instance of
<tt class="class">UserString</tt> (or a subclass) or an arbitrary sequence which can
be converted into a string using the built-in <tt class="function">str()</tt> function.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-842' xml:id='l2h-842' class="class">MutableString</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>sequence</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
This class is derived from the <tt class="class">UserString</tt> above and redefines
strings to be <em>mutable</em>.  Mutable strings can't be used as
dictionary keys, because dictionaries require <em>immutable</em> objects as
keys.  The main intention of this class is to serve as an educational
example for inheritance and necessity to remove (override) the
<tt class="method">__hash__()</tt> method in order to trap attempts to use a
mutable object as dictionary key, which would be otherwise very
error prone and hard to track down.
</dl>

<p>
In addition to supporting the methods and operations of string and
Unicode objects (see section <a href="string-methods.html#string-methods">3.6.1</a>, ``String
Methods''), <tt class="class">UserString</tt> instances provide the following
attribute:

<p>
<dl><dt><b><tt id='l2h-843' xml:id='l2h-843' class="member">data</tt></b></dt>
<dd>
A real Python string or Unicode object used to store the content of the
<tt class="class">UserString</tt> class.
</dl>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="5.13 userlist  "
  href="module-UserList.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="5. data Types"
  href="datatypes.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="5.15 types  "
  href="module-types.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-UserList.html">5.13 UserList  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="datatypes.html">5. Data Types</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-types.html">5.15 types  </a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
